Socket
Socket
Sign inDemoInstall

@uppy/status-bar

Package Overview
Dependencies
4
Maintainers
5
Versions
96
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

@uppy/status-bar


Version published
Maintainers
5
Install size
3.20 MB
Created

Package description

What is @uppy/status-bar?

@uppy/status-bar is a plugin for the Uppy file uploader that provides a status bar to show upload progress, pause/resume functionality, and error handling. It integrates seamlessly with Uppy to give users a visual representation of their file upload status.

What are @uppy/status-bar's main functionalities?

Basic Setup

This code demonstrates how to set up the @uppy/status-bar plugin with Uppy. It initializes Uppy and uses the StatusBar plugin, attaching it to the body of the document and configuring it to hide after the upload is finished.

const Uppy = require('@uppy/core');
const StatusBar = require('@uppy/status-bar');

const uppy = Uppy();
uppy.use(StatusBar, {
  target: 'body',
  hideAfterFinish: true
});

Customizing Status Bar

This code shows how to customize the status bar by changing its target element, keeping it visible after the upload is finished, and showing detailed progress information.

const Uppy = require('@uppy/core');
const StatusBar = require('@uppy/status-bar');

const uppy = Uppy();
uppy.use(StatusBar, {
  target: '#upload-status',
  hideAfterFinish: false,
  showProgressDetails: true
});

Handling Upload Events

This code demonstrates how to handle upload events such as 'upload-success' and 'upload-error' with Uppy and the StatusBar plugin. It logs the results of successful uploads and errors to the console.

const Uppy = require('@uppy/core');
const StatusBar = require('@uppy/status-bar');

const uppy = Uppy();
uppy.use(StatusBar, {
  target: 'body'
});

uppy.on('upload-success', (file, response) => {
  console.log('Upload successful:', file, response);
});

uppy.on('upload-error', (file, error) => {
  console.error('Upload error:', file, error);
});

Other packages similar to @uppy/status-bar

Readme

Source

@uppy/status-bar

Uppy logo: a smiling puppy above a pink upwards arrow

npm version CI status for Uppy tests CI status for Companion tests CI status for browser tests

The status-bar shows upload progress and speed, ETAs, pre- and post-processing information, and allows users to control (pause/resume/cancel) the upload. Best used together with a basic file source plugin, such as @uppy/file-input or @uppy/drag-drop, or a custom implementation. It’s also included in the @uppy/dashboard plugin.

Uppy is being developed by the folks at Transloadit, a versatile file encoding service.

Example

import Uppy from '@uppy/core'
import StatusBar from '@uppy/status-bar'

const uppy = new Uppy()
uppy.use(StatusBar, {
  target: 'body',
  hideUploadButton: false,
  showProgressDetails: false,
  hideAfterFinish: true,
})

Installation

$ npm install @uppy/status-bar

Alternatively, you can also use this plugin in a pre-built bundle from Transloadit’s CDN: Edgly. In that case Uppy will attach itself to the global window.Uppy object. See the main Uppy documentation for instructions.

Documentation

Documentation for this plugin can be found on the Uppy website.

License

The MIT License.

Keywords

FAQs

Last updated on 08 May 2024

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Packages

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc